home *** CD-ROM | disk | FTP | other *** search
/ Floppyshop 2 / Floppyshop - 2.zip / Floppyshop - 2.iso / diskmags / 4671-5.790 / dmg-5425 / rdd.txt < prev   
Text File  |  1989-12-31  |  21KB  |  421 lines

  1.         
  2.                          The Revenge Document Displayer
  3.         
  4.                     Copyright (c)1990,91,92,93 Stuart Coates
  5.         
  6.                                   Version 3.00
  7.         
  8.                                 23rd October 1993
  9.         
  10.         
  11.         Welcome  to  the  Revenge  Document  Displayer  v3  (RDD3).   The 
  12.         objective  with the release of RDD3 is to provide a text  viewing 
  13.         utility  for  the Atari ST range of micros that is  powerful  and 
  14.         easy  to  use.   Previous versions of RDD had a  vast  number  of 
  15.         options available to the user,  RDD3 has omitted some of the less 
  16.         used  features of previous releases but has gained  several  very 
  17.         powerful ones.
  18.         
  19.         
  20.         A Brief History
  21.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  22.         The  RDD v1.00 was released on 15th April 1990 in response  to  a 
  23.         request from a friend of mine for a text viewing utility that was 
  24.         more flexible than the GEM Desktop's own.  RDD1.00 was written in 
  25.         Hisoft  Basic  and didn't contain many features.   I  decided  to 
  26.         develop the idea of the RDD from this base with several  releases 
  27.         throughout  the  year  resulting in RDD  1.93  released  on  28th 
  28.         October 1990.   That Xmas I purchased Lattice C v5.00 and decided 
  29.         to learn C - no better way than to port RDD to C.
  30.         
  31.         RDD  v2.00 was released on 3rd February 1991 and  contained  many 
  32.         more features and was a lot faster.   RDD2 was a lot more  stable 
  33.         than RDD1 because of this rewrite.   During 1991 and 1992 no less 
  34.         than  21  versions were released and 14  organisations  purchased 
  35.         custom copies.   Several other text viewers sprang up during this 
  36.         time  which  I'm grateful for as they gave me new ideas  for  the 
  37.         RDD,  this  also gave the ST community greater  choice.   Version 
  38.         2.30  was released on 27th September 1992 and was the  last  RDD2 
  39.         release. 
  40.         
  41.         I received a large amount of feedback from RDD2 which  encouraged 
  42.         me  to  start  work on RDD3 in December  1992.   The  first  beta 
  43.         release  was shipped to testers in January 1993.   Very few  bugs 
  44.         were found in this although many features were missing.  The RDD3 
  45.         that you see today has taken many months to develop and has  been 
  46.         thoroughly tested.
  47.         
  48.         
  49.         Using The RDD3
  50.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  51.         Loading a document:
  52.         
  53.         There are several way to load documents into the RDD3,
  54.         
  55.         1.   Double click on RDD.PRG from the desktop and use the GEM file 
  56.         selector to pick a document.
  57.         
  58.         2.   Rename  RDD.PRG to RDD.TTP and enter a document name on  the 
  59.         command line when running.
  60.         
  61.         3.   Install RDD.PRG as an application on the desktop so that  it 
  62.         is loaded every time that you click on a text file.
  63.         
  64.         4.   If  you have TOS2 installed or one of the  many  replacement 
  65.         desktops that allow you to place items on the desktop then  place 
  66.         the RDD3 on the desktop and you can simply drag documents to  it. 
  67.         (I strongly recommend Terradesk for this).
  68.         
  69.         5.   Machines running Neodesk 3 can have the RDD installed as the 
  70.         default  text  viewer so that any docs are  displayed  using  the 
  71.         RDD3. 
  72.         
  73.         6.   (For programmers only..)  Launch the RDD from your own shell 
  74.         using the GEMDOS Pexec function.   On the command line you should 
  75.         pass  a  list  of documents that you wish to  load  separated  by 
  76.         spaces.  The RDD3 supports the ARGV protocol for extended command 
  77.         lines.
  78.         
  79.         
  80.         Loading Multiple Documents:
  81.         
  82.         The  RDD3 has support for multiple documents in memory,  in  fact 
  83.         currently  up  to 200 docs can be resident at once,  this  is  of 
  84.         course dependent on available memory.   To load more than one doc 
  85.         you  can  either  specify individual filenames  or  use  wildcard 
  86.         matches,  for  example if you wanted to load all .TXT files  then 
  87.         tell  the RDD3 to load *.TXT.   The RDD3 also understands  folder 
  88.         structures,  so to load all of the documents within a folder just 
  89.         specify  the  folder  name.   The  RDD3  does  not  scan  folders 
  90.         recursively.
  91.         
  92.         
  93.         Compressed Documents
  94.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  95.         RDD3 supports documents that have been compressed using  Pack-Ice 
  96.         2.40,  this allows you to have an archive of compressed documents 
  97.         that don't eat up huge amounts of disk space.
  98.         
  99.         Archive Files
  100.         ¯¯¯¯¯¯¯¯¯¯¯¯¯
  101.         RDD3  can  recognise  most popular archive formats  and  has  the 
  102.         ability  to  perform a verbose listing of the  archive  contents.  
  103.         The  current release of RDD supports  ZIP,ARC,ZOO,ARJ,LZH  files.  
  104.         To  make  use of this feature simply load the  archive  file,  to 
  105.         bypass the automatic listing feature hold down the Alternate  key 
  106.         while loading the archive.
  107.         
  108.         Pictures
  109.         ¯¯¯¯¯¯¯¯
  110.         RDD3  has limited support for Degas PI?  picture files  and  will 
  111.         only display pictures that are compatible with the current screen 
  112.         resolution.   When a picture is loaded a document will be created 
  113.         with the line:  'PICFILE:  <filename>',  press Alt-V to view this 
  114.         picture.
  115.         
  116.         Document Formatting
  117.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  118.         Before  a  document  can  be displayed by the  RDD3  it  must  be 
  119.         formatted,  this  is done whenever a doc is  loaded.   Formatting 
  120.         causes  any  long  lines  within that doc to  be  wrapped  at  80 
  121.         characters and tab characters to be expanded.
  122.         
  123.         
  124.         On-Line Help
  125.         ¯¯¯¯¯¯¯¯¯¯¯¯
  126.         The  RDD3  has built in help that gives you a  list  of  keyboard 
  127.         controls, to gain access to this press HELP while you are viewing 
  128.         a document.
  129.         
  130.         
  131.         Main Features
  132.         ¯¯¯¯¯¯¯¯¯¯¯¯¯
  133.         I'm  not going to go through every feature in the RDD3  in  great 
  134.         detail as that would take far too long and you probably  wouldn't 
  135.         want to read it anyway,  so I'll just list the main features  and 
  136.         give a small explanation for each.
  137.         
  138.         Scrolling:  Probably the most important feature, to scroll up and 
  139.         down use the arrow keys or move the mouse up and down.   You  can 
  140.         also  move  a screen at a time by holding down either  shift  key 
  141.         while scrolling.
  142.         
  143.         Move  to Top or Bottom of Doc:   Press Alt-T to go to the top  or 
  144.         Alt-B to go to the bottom
  145.         
  146.         Goto a line: To go to a particular line press Alt-G and enter the 
  147.         line number that you want to go to.
  148.         
  149.         Find a word:  Press Alt-F to search for a piece of text.  You can 
  150.         also set up case-sensitive and global searches using this option.  
  151.         Pressing  Alt-N and Alt-P allow you to find the Next or  Previous 
  152.         occurrence.
  153.         
  154.         Load a document:   To load another document press Alt-L or  click 
  155.         the  right mouse button,  you will then be presented with a  file 
  156.         selector,  select the file that you wish to load and the RDD will 
  157.         do the rest.   The contents of the Atari clipboard can be  loaded 
  158.         by pressing Ctrl-A.
  159.         
  160.         Close a document:  When you've finished with a document hit Alt-C 
  161.         to close it.
  162.         
  163.         Switching Documents:  If you've got several documents loaded then 
  164.         you can switch between them in several ways:
  165.         
  166.              Keypad -       Move to previous document
  167.              Keypad +       Move to next document
  168.              Tab            Show list of loaded documents
  169.              F1-10          Move to document 1-10
  170.              Shift F1-F10   Move to document 11-20
  171.         
  172.         Changing tab width:   Press Ctrl-T to change the tab setting  for 
  173.         the current document.   Tab settings are stored on a per document 
  174.         basis.
  175.         
  176.         Printing a Document:   Press Ctrl-P to print the current document 
  177.         and Ctrl-C to configure the printer.  Ctrl-W will let you print a 
  178.         marked block.
  179.         
  180.         Marking  a block:   Alt-S and Alt-E allow you to start and end  a 
  181.         block,  pressing Alt-H will hide any block.  A block can be saved 
  182.         to disk by pressing Alt-W,  or to the Atari clipboard by pressing 
  183.         Alt A.
  184.         
  185.         Locate RDD:  Pressing Ctrl-L will allow you to locate the RDD.PRG 
  186.         file  to  allow a configuration file to be saved in  the  correct 
  187.         directory.   Press Ctrl-L and the file selector will appear, find 
  188.         the  RDD.PRG file and select it.   The RDD.PRG file will  now  be 
  189.         loaded and its location encoded within it.
  190.         
  191.         Save settings: The configuration can be saved by pressing Ctrl-S.  
  192.         Before  using  this option for the first time you  must  run  the 
  193.         'Locate RDD' option.
  194.         
  195.         Bookmarks:  You  can store the current position in a document  by 
  196.         setting  a  bookmark.   RDD3 supports 26  bookmarks.   To  set  a 
  197.         bookmark simply press Shift and any letter A-Z.   You can  return 
  198.         to  a stored bookmark by hitting just the letter  A-Z.   You  can 
  199.         also set bookmarks by pressing Ctrl-B.  Bookmarks can be accessed 
  200.         easily by pressing Alt-M.
  201.         
  202.         ST/IBM Characters:  RDD3 supports both ST and IBM character sets, 
  203.         you can toggle between them by pressing Escape. 
  204.         
  205.         Feature  menu:   RDD3  features  a  menu  that  you  can  perform 
  206.         operations from without using any strange key combinations.  This 
  207.         menu  can  be  accessed  by clicking the  left  mouse  button  or 
  208.         pressing Insert.
  209.         
  210.         Toggle Text Size:   If you're using a high rez monitor with  your 
  211.         ST then the RDD3 can display a 50 line text mode, press Ctrl-G to 
  212.         toggle between 25 and 50 line modes.
  213.         
  214.         50/60Hz:   On  colour  screens  you can  toggle  between  50/60Hz 
  215.         refresh  rates by pressing Keypad *,   not all  monitors  support 
  216.         this feature.
  217.         
  218.         Locate  external editor:   The RDD has the ability of support  an 
  219.         external editor program to manipulate documents.  To tell the RDD 
  220.         the location of this program press Ctrl-D.
  221.         
  222.         Execute  external editor:   To load the current document into  an 
  223.         external  editor press Alt-D.   The current document will be  re-
  224.         loaded after editing.
  225.         
  226.         Document  Information:   To  obtain  statistics  on  the  current 
  227.         document press Clr Home.
  228.         
  229.         View Picture:  If a line with the structure 'PICFILE: <filename>' 
  230.         is at the top of the screen, pressing Alt-V will display it.
  231.         
  232.         Sorting  Documents:   If you have many documents loaded into  the 
  233.         RDD you can sort them into alphabetical by pressing Alt-O.  Using 
  234.         this option will result in all bookmarks being cleared.
  235.         
  236.         Running  External Programs:   The run an external  program  press 
  237.         Alt-X  and select the program that you require.   If the  current 
  238.         document  is an executable file then you can press Ctrl-X to  run 
  239.         it.
  240.         
  241.         Utilities:   The  RDD has the ability to store up to 20  external 
  242.         utilities  that are accessible with a  single  keystroke.   These 
  243.         programs can be set up two ways.   Press Ctrl-U or Ctrl-0 to 9 to 
  244.         locate a utility.  A utility can be accessed by either picking it 
  245.         from  a  menu by pressing Alt-U or by  pressing  the  appropriate 
  246.         number key, 0 to 9. 
  247.         
  248.         Mouse Control:   The mouse plays an important role in the use  of 
  249.         the RDD.  You can scroll through documents by moving the mouse up 
  250.         and down and call up the feature menu by pressing the left  mouse 
  251.         button.   The  mouse  can  also  be used  within  menus  to  make 
  252.         selections.   In fact,  although the RDD is a text based program, 
  253.         all of its features can be accessed via the mouse.
  254.         
  255.         Getting  Help:   If  you require help while using the  RDD  press 
  256.         the Help key for a list of available help topics.
  257.         
  258.         Exiting:  To exit from the RDD press the UNDO key twice.
  259.         
  260.         
  261.         Compatibility
  262.         ¯¯¯¯¯¯¯¯¯¯¯¯¯
  263.         The  RDD3 was written on an Atari 520STe with 4MB of RAM and  TOS 
  264.         1.62,  therefore  it  should be 100% compatible  with  a  similar 
  265.         platform.    The   beta   testers  of  the  RDD3   have   varying 
  266.         configurations  and  have not reported any problems in  the  many 
  267.         months  of  testing.   The code for the RDD3 does  not  make  any 
  268.         illegal  calls  and does not rely on any special  hardware  being 
  269.         present (blitter,  hardware scrolling,  etc...) so should work on 
  270.         most configurations.   If you plan to run RDD3 on a TT or  Falcon 
  271.         then  you  must select an ST screen resolution as the  RDD3  text 
  272.         routines do require this.  If I eventually get access to a Falcon 
  273.         I shall make the RDD3 fully compatible.   I have made a guess  on 
  274.         making  the RDD3 compatible with MultiTOS - if there is a  'MiNT' 
  275.         entry  in the cookie jar then the RDD3 will resort to using  just 
  276.         VT52 codes to draw the screen so that it may be ran in a  console 
  277.         window.   Due to Atari's unwillingness to place technical details 
  278.         of  its machines and operating systems into the public  domain  I 
  279.         cannot make the RDD compatible with machines that I do not own or 
  280.         have regular access to.   If Atari changed its policy of charging 
  281.         large  amounts of cash for technical documents then the  software 
  282.         produced for the ST (and the rest of its machines) would be of  a 
  283.         higher quality and more compatible.
  284.         
  285.         The  RDD3  should not conflict with any other programs  that  are 
  286.         running  on  your  machine as it only  accesses  memory  that  it 
  287.         allocates itself.   When RDD1 was released I did notice a problem 
  288.         with TurboST 1.82 when the RDD changed screen resolution,  I  can 
  289.         only  assume that this problem still exists in RDD3 as  the  same 
  290.         TOS call is used - This is a problem with TurboST.
  291.         
  292.         
  293.         System Requirements
  294.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  295.         The RDD3 will run on anything from a 520ST upwards.   If you plan 
  296.         to make extensive use of the multi-document features then  you'll 
  297.         be needing plenty of memory.  To gain extra speed from a basic ST 
  298.         the RDD3 uses highly optimized text routines for all of it's text 
  299.         output  and scrolling.   If you have a screen accelerator  loaded 
  300.         such  as Warp 9,  QuickST,  or TurboST,  you will not notice  any 
  301.         speed  change  at  all while using the RDD3 as  my  routines  are 
  302.         faster and completely bypass the TOS routines.
  303.         
  304.         
  305.         RDD3 Program Details
  306.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  307.         Design and Coding                  Stuart Coates
  308.         
  309.         Beta testers                       Mark Matts
  310.                                            Keith Frisby
  311.                                            Trev Ward
  312.                                            Gordon Meyer
  313.                                            John Charles
  314.                                            Robert Darling
  315.                                            Stuart Richards
  316.                                            Daron Brewood
  317.         
  318.         Development Tools                  Lattice C v5.52
  319.                                            Devpac 3.10
  320.                                            Harlekin 2
  321.         
  322.         Development Hardware               Atari 520STe
  323.                                            16MHz Accelerator
  324.                                            4MB Ram
  325.                                            48MB Seagate 157N
  326.                                            Atari SM124
  327.         
  328.         Essential Development Tools        Jolt Cola
  329.                                            Infectious Grooves CDs
  330.                                            Yngwie Malmsteen CDs
  331.                                            Bill & Ted Videos
  332.                                            Sega Mega CD
  333.         
  334.         Support
  335.         ¯¯¯¯¯¯¯
  336.         The  RDD3  is a complex program and therefore  may  contain  some 
  337.         bugs.  I would be very grateful if you could report any bugs that 
  338.         you  find direct to myself via email (addresses below) or if  you 
  339.         don't have email access then via my support BBS sysop Mark  Matts 
  340.         at the address below:
  341.         
  342.                                  Mark Matts
  343.                                  66 Telford Way
  344.                                  Leicester LE5 2LX
  345.                                  England U.K.
  346.         
  347.         My email addresses:
  348.         
  349.           (preferred)      Internet  : scoates@filesys.demon.co.uk
  350.                            Compuserve: 100010,2106
  351.                            Fidonet   : 2:255/320.42
  352.                            NeST      : 90:100/101.42
  353.                            Atarinet  : 51:6/4.42
  354.         
  355.         Official support BBS:
  356.         
  357.                            System ST BBS
  358.                            Inside UK    : 0533 413443
  359.                            International: +44 533 413443
  360.                            Times        : 2200-0700 GMT
  361.                            Speeds       : 1200-9600
  362.         
  363.         The  very  latest version of RDD can always  be  downloaded  from 
  364.         System ST first,  and from Compuserve within a couple of days  of 
  365.         release in the ATARIPRO forum.
  366.         
  367.         
  368.         Registration
  369.         ¯¯¯¯¯¯¯¯¯¯¯¯
  370.         The  RDD is distributed as shareware which means that if you  use 
  371.         it then you're expected to register.   The registration fee is  5 
  372.         pounds  sterling (or US$10) and should be sent to my support  BBS 
  373.         sysop, Mark Matts (his address is mentioned earlier in this doc).  
  374.         All  registered users will receive a copy of the latest  version.  
  375.         The  latest  version of the RDD will also be made  available  via 
  376.         various BBS's and on-line systems.  If you don't have access to a 
  377.         modem then you can obtain a copy of the latest version by sending 
  378.         a blank disk and 2 pounds sterling (or US$4) to Mark Matts.   The 
  379.         RDD  may be distributed freely by any PD Library or BBS  but  may 
  380.         not  be used on any magazine cover disk without  permission  from 
  381.         the   author,   any  magazine  failing  to  comply   with   these 
  382.         restrictions  will  have action taken against  them.   Disk  only 
  383.         magazines are free to use the RDD without the authors  permission 
  384.         on  the condition that a copy of the relevant edition is sent  to 
  385.         Mark Matts in advance of publication.
  386.         
  387.         
  388.         Why no direct support?
  389.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  390.         I'm not publishing my current address as it is currently changing 
  391.         every  few  months and this would result in  some  correspondence 
  392.         being lost.   Mark Matts has offered to handle all  registrations 
  393.         and correspondence on my behalf and will forward any bug  reports 
  394.         direct to myself.  I do have several email addresses available if 
  395.         you do require to contact me.
  396.         
  397.         
  398.         Future plans for RDD:
  399.         ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  400.         The RDD is undergoing continual development, some of the features 
  401.         that  are  likely to be included in future  releases  are  listed 
  402.         below.   If you have any suggestions for additional features then 
  403.         please contact either the author or Mark Matts.
  404.         
  405.         Future features:
  406.         
  407.         Support  for non-ST screen resolutions - including all  Falcon/TT 
  408.         modes and third party high resolution boards.
  409.         
  410.         Greater  support  for picture files - really  dependent  on  user 
  411.         feedback  -  do  you  really need  a  doc  displayer  to  display 
  412.         pictures?
  413.         
  414.         Support  for MultiTOS / MiNT / Geneva - background  printing  and 
  415.         document formatting.
  416.         
  417.         Full  support  for the Falcon 030/040 including the  DSP  -  just 
  418.         imagine the scrolling speed that this would be capable of -  need 
  419.         to get my hands on a Falcon!
  420.         
  421.